Skip to content

Comments

Implement automatic model calibration#238

Merged
paulf81 merged 171 commits intoNatLabRockies:developfrom
paulf81:feature/modelfit_2
Sep 26, 2025
Merged

Implement automatic model calibration#238
paulf81 merged 171 commits intoNatLabRockies:developfrom
paulf81:feature/modelfit_2

Conversation

@paulf81
Copy link
Collaborator

@paulf81 paulf81 commented Nov 8, 2024 •
edited
Loading

Implement automatic model calibration

This pull request adds a new class to FLASC: ModelFit. Currently under development the new class implements a new paradigm for automatic model calibration. The PR includes new examples and will include additional documentation.

Checklist of work to go:

  • Update examples to match latest uses
  • Decide which cost function to keep/delete/rename
  • Add opt sweep to optimization module and include an example
  • Remove temporary code
  • Hide/delete former methods of calibration
  • Add deprecation warnings to old code
  • Complete testing
  • Add docs
  • Add examples using optuna plots to show parameter importance etc.,
  • Update smarteole examples
  • Decide if we should use custom cost function in smarteole example
  • List out un-related changes

Review of changes

  • Model fit class added fo flasc/model_fitting
  • floris_tuning.py is notably deprecated
  • testing of model_fit. (and cost and opt functions added)
  • testing of floris_tuning deprecated
  • new dependencies added
  • model fit add to docs and docs cleaned up a bit to organize flow

Unrelated linting-type changes that got grouped in

  • emgauss.yaml is formatted
  • several of the smarteole examples (notebooks) were re-run and saved but not clearly updated meaninfully
  • a duplicate wind_up notebook is removed

Flying below the radar

results_analysis.py, which was useful for conducting analysis of results generated from model_fit in other projects in included but not yet linked into any examples or docs. This is probably ok for this first pass.

Feature or improvement description
This PR replaces #213

misi9170 and others added 30 commits September 4, 2024 17:16
@misi9170 @paulf81 @christiannvaughn
Add new FlascDataFrame object to enhance user interface with data (N…
bdc95e0 
…atLabRockies#199)

* Adding at the root level for now; could consider moving to utilities/

* Ruff.

* precommit stuff.

* Add example notebook

* Add wide to long

* Add test

* Update README.md engagement

* Update README.md replacing 'FLORIS' typo

* Feature/add docstrings (NatLabRockies#197)

* Update to 15 (NatLabRockies#202)

* Update for PyPI installation. (NatLabRockies#204)

* Update version number; ignore version.py for ruff.

* Adhere to FLASC formatting rules.

* psuedocode for conversions. Tests for saving dataframe to file.

* Print warning when to_feather used.

* String formatting.

* Add several more tests and n_turbines property.

* Adding TODOs for long/wide conversions.

* Clean up, a few more tests.

* Improved printout.

* ruff format.

---------

Co-authored-by: Paul <paul.fleming@nrel.gov>
Co-authored-by: christiannvaughn <139596563+christiannvaughn@users.noreply.github.com>
@paulf81
Add dataframe conversions to flascdataframe (NatLabRockies#211)
ff8e962
@aclerc
Add wind up example using FlascDataFrame (NatLabRockies#210)
ebe1451
@paulf81
loosen wind-up dependency
fb6ff8d
@paulf81
Add examples
67a0de9
@paulf81
add model fit
9f0fa08
@paulf81
add tests
1877d34
@paulf81
Clean up a little
9ce5b60
@paulf81
Reorganize
3d41415
@paulf81
Ignore data holding output files
7d61e56
@paulf81
Generate farm data
7c5cf43
@paulf81
Add turbine_groupings to cost routing
416effc
@paulf81
Cost function optimization library
005a028
@paulf81
bugfix
9b0a8e8
@paulf81
Can't insist on time
db45287
@paulf81
Add optimizations
a2ce114
@paulf81
Add a test notebook
19d8921
@paulf81
small update
4532db4
@paulf81
Don't copy floris model
d2acbb3
@paulf81
add optuna
d14a177
@paulf81
reorg and add optuna
5091d24
@paulf81
Update example
de66ad8
@paulf81
Merge branch 'develop' into feature/modelfit_2
9d79cc9
@paulf81
Merge branch 'develop' into feature/modelfit_2
f7547d8
@paulf81
Add optuna dependecy
1e8cdf7
@paulf81
Merge branch 'develop' into feature/modelfit_2
34167a0
@paulf81
Merge branch 'develop' into feature/modelfit_2
570f661
@paulf81
Update to parflorismodel
5dba5ad
@paulf81
clean up docs
2668f9f
@paulf81
Merge branch 'develop' into feature/modelfit_2
569bf4c
@paulf81
Copy link
Collaborator Author

paulf81 commented Sep 25, 2025

First follow-up comment is the ResultsAnalysis is out

@misi9170
Copy link
Collaborator

misi9170 commented Sep 25, 2025

@paulf81 regarding the verbose flag for Optuna---I think it's something we can fix. The verbose option in opt_optuna() simply isn't used---probably there's a way to pass it along to the actual optuna call :)

@paulf81
Copy link
Collaborator Author

paulf81 commented Sep 25, 2025

@misi9170 on form_flasc_dataframe it is only used in that example so it could fairly go. My only pause is that it isn't totally useless, it could for example instead of just being cut, moved to utilities, or utilities_examples. Which would you prefer?

@misi9170
Copy link
Collaborator

misi9170 commented Sep 25, 2025

@misi9170 on form_flasc_dataframe it is only used in that example so it could fairly go. My only pause is that it isn't totally useless, it could for example instead of just being cut, moved to utilities, or utilities_examples. Which would you prefer?

I guess I'm not really seeing what it's adding compared to just actually instantiating a FlascDataFrame from scratch?

@paulf81
Copy link
Collaborator Author

paulf81 commented Sep 25, 2025

@misi9170 on form_flasc_dataframe it is only used in that example so it could fairly go. My only pause is that it isn't totally useless, it could for example instead of just being cut, moved to utilities, or utilities_examples. Which would you prefer?

I guess I'm not really seeing what it's adding compared to just actually instantiating a FlascDataFrame from scratch?

Ok, I'll kill it

@paulf81
Copy link
Collaborator Author

paulf81 commented Sep 25, 2025

Also I tracked down the parallel thing, in very early versions of things, we were converting all ParallelFlorisModel under the hood but got rid of that and just never caught up the examples. I think the best thing to do could be to remove the language from the examples,

Question for you @misi9170, do you think useful to include a parallel example that does use ParFlorisModel

@paulf81
Copy link
Collaborator Author

paulf81 commented Sep 25, 2025

@misi9170 on form_flasc_dataframe it is only used in that example so it could fairly go. My only pause is that it isn't totally useless, it could for example instead of just being cut, moved to utilities, or utilities_examples. Which would you prefer?

I guess I'm not really seeing what it's adding compared to just actually instantiating a FlascDataFrame from scratch?

Ok, I'll kill it

On second thought I found where it's used in the ModelFit process and while I could make it inline, I thought just switching it to a private member function was a little cleaner

paulf81 and others added 19 commits September 25, 2025 10:58
@paulf81
remove repeat label
c042713
@misi9170
Small udpate to deprecation language
281224e
@paulf81
Remove un-needed par blocking
1a9fada
@paulf81
Add parallel example
37f6273
@paulf81
Merge branch 'feature/modelfit_2' of github.com:paulf81/flasc into pr…
47b34db 
…/paulf81/238
@paulf81
Chain verbose through
445e622
@paulf81
Merge branch 'develop' into pr/paulf81/238
f73137a
@paulf81
chain verbose through
9a45153
@misi9170
Revert unneeded changes in smarteole examples
4e215b0
@misi9170
Reinstate model_tuning_test
00d68c2
@paulf81
Delete old code
dd0db6b
@paulf81
Update how TI is handled
9aae028
@misi9170
Add note on emgauss defaults
3323847
@paulf81
remove great tables
485654a
@misi9170
add cost library tests and fix some bugs in cost function classes
9187bc7
@paulf81
Add option to use non-default wd_sample_points
ec9836c
@paulf81
Merge branch 'feature/modelfit_2' of github.com:paulf81/flasc into pr…
e3e6fe2 
…/paulf81/238
@paulf81
linting
62068a2
@paulf81
linting
07ae8ad
@paulf81 paulf81 merged commit 5526fd6 into NatLabRockies:develop Sep 26, 2025
3 checks passed
@paulf81 paulf81 deleted the feature/modelfit_2 branch September 26, 2025 03:53
@misi9170 misi9170 mentioned this pull request Sep 30, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@misi9170 misi9170 misi9170 requested changes

Assignees

@paulf81 paulf81

Labels

new-feature A new feature

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@paulf81 @misi9170 @aclerc